Class AbstractIterator

Summary

Fully Qualified Name: Zend\Permissions\Rbac\AbstractIterator
Implements: RecursiveIterator

Description

Methods

Name Description Defined By
current() (PHP 5 >= 5.0.0)
Return the current element
AbstractIterator
getChildren() (PHP 5 >= 5.1.0)
Returns an iterator for the current entry.
AbstractIterator
hasChildren() (PHP 5 >= 5.1.0)
Returns if an iterator can be created fot the current entry.
AbstractIterator
key() (PHP 5 >= 5.0.0)
Return the key of the current element
AbstractIterator
next() (PHP 5 >= 5.0.0)
Move forward to next element
AbstractIterator
rewind() (PHP 5 >= 5.0.0)
Rewind the Iterator to the first element
AbstractIterator
valid() (PHP 5 >= 5.0.0)
Checks if current position is valid
AbstractIterator

Method Details

current()

(PHP 5 >= 5.0.0)
Return the current element

Returns: mixed Can return any type.

getChildren()

(PHP 5 >= 5.1.0)
Returns an iterator for the current entry.

Returns: \RecursiveIterator An iterator for the current entry.

hasChildren()

(PHP 5 >= 5.1.0)
Returns if an iterator can be created fot the current entry.

Returns: bool true if the current entry can be iterated over, otherwise returns false.

key()

(PHP 5 >= 5.0.0)
Return the key of the current element

Returns: int|null scalar on success, or null on failure.

next()

(PHP 5 >= 5.0.0)
Move forward to next element

Returns: void Any returned value is ignored.

rewind()

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

Returns: void Any returned value is ignored.

valid()

(PHP 5 >= 5.0.0)
Checks if current position is valid

Returns: bool The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

Top